home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / uucp / wcnews_1_0_30.lha / doc / install.amiga.man < prev    next >
Text File  |  1994-01-04  |  17KB  |  397 lines

  1.  
  2.  
  3.  
  4. Install.Amiga(­)              wCNews             Install.Amiga(­)
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                     ›1mDifferences›22m ›1mregarding›22m ›1mthe›22m
  12.         ›1mInstallation›22m ›1mof›22m ›1m``C›22m ›1mNews''›22m ›1mNetwork›22m ›1mNews›22m ›1mSoftware›22m
  13.                  ›1mon›22m ›1mCommodore®›22m ›1mAmiga®›22m ›1mComputers›22m
  14.  
  15.  
  16.                            Kai Siering
  17.  
  18.                         Villa Straylight
  19.                       Hamburg, West Germany
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.           This  document  describes the basic installa­
  27.           tion of the CNews package (›4mwCNews›24m) on top  of
  28.           Amiga  UUCP.  For  general  information about
  29.           ›4mCNews›24m, please refer to ›4minstall.man›24m
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38. ›1mIntroduction›22m
  39.  
  40.      This is CNews, based on the port done by  ›1mFrank›22m ›1m'Crash'›22m  ›1mEd­›22m
  41. ›1mwards›22m  in  1990, enhanced & bugfixed in 1992 by ›1mKai›22m ›1m'wusel'›22m ›1mSier­›22m
  42. ›1ming›22m.  Together with some additional programs, written  by  ›1mWalter›22m
  43. ›1m'wasp'›22m  ›1mMildenberger›22m, ›1mMatthew›22m ›1mDillon›22m, and ›1mIngo›22m ›1mFeulner›22m, I release
  44. this as ›4mwCNews›24m.
  45.  
  46.      Despite the UN*X version, this package is not based on  lots
  47. of auxillary shell scripts. Although their functionality has been
  48. enhanced in OS 2.0, they still lack the ability to get input from
  49. stdin  and certain other features that would be helpful.  For the
  50. original port, there are some ›4mAREXX›24m scripts which seem to help  a
  51. lot  running CNews on the Amiga; and then there are several UN*X­
  52. like shells, which eventually could be used in order to adopt the
  53. ›4m/bin/sh›24m scripts of CNews.
  54.      But  actually  I  can't  see a mayor advantage using scripts
  55. (except that they are easy to change to local needs) ­  I  prefer
  56. compiled programs for efficiency.
  57.      I  never used the AREXX scripts myself (as on a plain 68000,
  58. all I got from using AREXX was time for another cup  of  coffee),
  59. but  the scripts that came with the original port (especially the
  60. ones for batching and unbatching)  were  error­prone  and  didn't
  61.  
  62.  
  63.  
  64. Villa Straylight Mon, 11 Jan 1993 06:04:20 +0100                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Install.Amiga(­)              wCNews             Install.Amiga(­)
  71.  
  72.  
  73. work  realiably  (sorry, Frank). And as I was using Ingo Feulners
  74. ›4mAmiga›24m ›4mUUCP›24m ›4mPlus›24m before, I knew there was another way ...
  75.  
  76.      Thus, I grabbed the sources and started to  modify  them  to
  77. fit  my needs.  After some time, I got Walter Mildenbergers ›4msend­›24m
  78. ›4mbatches›24m package which worked fine  for  me  (after  some  changes
  79. =:­>).  Next thing to change was the unbatching mechanism. I took
  80. the sources of Matthew Dillons ›4muuxqt›24m as a basis and created ›4mnews­›24m
  81. ›4mrun›24m (aka ›4munbatch›24m).
  82.      Then  came  some  bugfixes and enhancements to ›4mrelaynews›24m and
  83. ›4mexpire›24m.  The resulting system runs here  24h  a  day;  as  to  my
  84. knowledge,  there are no more bugs in it, although there is still
  85. a lot to do ...
  86.  
  87.  
  88.  
  89. ›1mCOPYRIGHT›22m
  90.  
  91. The contents of file ›4mCOPYRIGHT›24m follows:
  92.  
  93.      Copyright (c) University of Toronto 1985, 1986, 1987,  1988,
  94. 1989,  1990.   All  rights  reserved.  Written mostly by Geoffrey
  95. Collyer and Henry Spencer.  This software is not subject  to  any
  96. license  of the American Telephone and Telegraph Company, the Re­
  97. gents of the University of California, or the Free Software Foun­
  98. dation.
  99.  
  100. Permission is granted to anyone to use this software for any pur­
  101. pose on any computer system, and to alter it and redistribute  it
  102. freely, subject to the following restrictions:
  103.  
  104. 1. The authors are not responsible for the consequences of use of
  105.    this software, no matter how awful, even if  they  arise  from
  106.    flaws in it.
  107.  
  108. 2. The origin of this software must not be misrepresented, either
  109.    by explicit claim or by omission.  Since few users  ever  read
  110.    sources, credits must appear in the documentation.
  111.  
  112. 3. Altered  versions must be plainly marked as such, and must not
  113.    be misrepresented as being the original software.   Since  few
  114.    users ever read sources, credits must appear in the documenta­
  115.    tion.
  116.  
  117. 4. This notice may not be removed or altered.
  118.  
  119.  
  120.  
  121. ›1mDescription›22m ›1mof›22m ›1mChanges›22m
  122.  
  123.      As I havn't changed the original  documentation,  there  are
  124. several  things to keep in mind when reading that docs; sorry for
  125. any inconvenience.
  126.  
  127.  
  128.  
  129.  
  130. Villa Straylight Mon, 11 Jan 1993 06:04:20 +0100                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. Install.Amiga(­)              wCNews             Install.Amiga(­)
  137.  
  138.  
  139.      ›4mRelaynews›24m   gets   it's    ›1mnewsname()›22m    from    the    file
  140. ›1muulib:news/whoami›22m;  if  this  does not exist (or contains nothing
  141. that looks like a hostname), a ›1mGetEnv("hostname");›22m is  performed.
  142. [›1mTechnical›22m  ›1mNote:›22m  all environment­related stuff uses the AmigaOS
  143. routines, that is local  environment  variables  take  precedence
  144. over  the  global  ones.]  If this fails too, the variables ›1mNODE­›22m
  145. ›1mNAME›22m, ›1mDOMAINNAME›22m, and ›1mDOMAINPATH›22m are consulted; the  latter  con­
  146. trols  wheter  or  not  the  FQDN is used (set it to ›1my›22m or ›1myes›22m for
  147. FQDN). These variables are looked up in  the  environment  first,
  148. then    in   the    ›4mAmiga›24m   ›4mUUCP›24m   ›4mgeneral›24m   ›4mconfiguration›24m   ›4mfile›24m
  149. (›1muulib:Config›22m),   environment   variable   ›1mCNEWS›22m   (defaults   to
  150. ›1m$NEWSCTL/CNews.Config›22m     or,     if     $NEWSCTL     is    unset
  151. ›1muulib:news/CNews.Config›22m), finally a more or less silly default is
  152. taken  ­  or an error is returned, depending of the importance of
  153. the variable in question.
  154.  
  155. You may argue that this scheme is more than chaotic  ­  I  agree.
  156. But  it  is the result of trying to make wCNews fit better in ex­
  157. isting Amiga UUCP Plus environments without  breaking  old  CNews
  158. configurations  ...   ›1mNOTE:›22m ›1mAlthought›22m ›1mthis›22m ›1mis›22m ›1man›22m ›1mintermediate›22m ›1mre­›22m
  159. ›1mlease,›22m ›1myou›22m ›1mshould›22m ›1muse›22m ›1m*only*›22m ›1meither›22m ›1muulib:Config›22m  ›1mor›22m  ›1menvironment›22m
  160. ›1mvariables›22m  ›1mfor›22m  ›1mconfiguration;›22m  ›1monly›22m ›1mthe›22m ›1mcore›22m ›1mCNews›22m ›1mprograms›22m ›1mmake›22m
  161. ›1muse›22m ›1mof›22m ›1mthe›22m ›1mCNews.Config­file›22m ›1mand›22m ›1mI›22m ›1mintend›22m  ›1mto›22m  ›1mdrop›22m  ›1msupport›22m  ›1mfor›22m
  162. ›1mthat›22m ›1mRSN!›22m ›1mYou›22m ›1mhave›22m ›1mbeen›22m ›1mwarned!›22m
  163.  
  164. Relaynews  can  be  set to be more nitpicking about the syntax of
  165. messages (as specified by ›4mRFC›24m ›4m1036›24m and ›4mRFC›24m ›4m822›24m). You may set  the
  166. variable  ›1mRFCStrictness›22m  to  a numeric value between ›1m0›22m and ›1m2›22m.  At
  167. level 0, it act as before, accepting a wide rage of  ­  according
  168. to RFC 1036 ­ illegal message­ids.  At level 1, relaynews insists
  169. at least on a RFC 822 conformant message­id (1036 is  more  rigid
  170. in  some  areas)  and refuses articles with illegal characters in
  171. their id (white­space, control chars) ­ that's the way most  UN*X
  172. systems  are  configured  nowadays.  Finally, set at level 2, re­
  173. laynews insist on fulfilling RFC 1036's complete message­id spec­
  174. ification (the domain part has to be fully qualified).
  175.  
  176. Furthermore,  you  can  set ›1mMaxArticleAge›22m to any positive numeric
  177. value (that makes sense); articles older MaxArticleAge days  will
  178. be  rejected by relaynews, as will articles with unparsable dates
  179. (althought my ›1mgetdate()›22m is more co­operative than  that  of  UN*X
  180. CNews  ...).  If  you  don't  set  this  variable, relaynews will
  181. silently ignore the `Date:' headers; but nowadays,  systems  run­
  182. ning  CNews or INN (›4mInterNetNews›24m) will reject too old or not con­
  183. forming articles anyway (without further notice!),  so  it  makes
  184. sense  to  do  this  locally too (saves transmission time and you
  185. won't loose your article into the bit bucket).
  186.  
  187. Last but not least, the ›1mlocking›22m ›1mmechanism›22m now  works  (done  with
  188. Matt  Dillons  ›1mlockfile.c›22m from the 1.15 distribution) ­ relaynews
  189. locks itself with ›1mLockFile("LockedCNews");›22m.  As  a  side  effect,
  190. you  may  now  deadlock your system when trying some weird things
  191. via the sys­file =:­> Be careful.
  192.  
  193.  
  194.  
  195.  
  196. Villa Straylight Mon, 11 Jan 1993 06:04:20 +0100                3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. Install.Amiga(­)              wCNews             Install.Amiga(­)
  203.  
  204.  
  205. Regarding the sys­file (›1muulib:news/sys›22m), you can now specify  ›4mex­›24m
  206. ›4mactly›24m  ›4mone›24m  ›4m`%s'›24m  in the sy_cmd field. It will be replaced with a
  207. filename under which the article is stored.  [›1mNote:›22m  In  case  of
  208. crosspostings,  this  file  may or may not point to a file in the
  209. subscription list ­ you'd better not delete  articles  in  groups
  210. you  don't  want  this  way  ...]  Thus, you may now have a shell
  211. script run in the background doing something  with  the  article:
  212. `fancy.things:alt.test/all::run my_cool_script %s'.
  213. Finally,  the  `f' flags now works as expected (it now DOES count
  214. ›1mXRef:›22m headers) ...
  215.  
  216.  
  217.  
  218.      ›4mExpire›24m has been enhanced to keep articles which it could not
  219. delete  (because of errors like ›1mFILE›22m ›1mPROTECTED›22m or ›1mFILE›22m ›1mIN›22m ›1mUSE›22m for
  220. example; ›1mFILE›22m ›1mNOT›22m ›1mFOUND›22m is just fine, that's what  we  wanted  as
  221. the  result  anyway  =:­>)  in the history. That way, the article
  222. will be tried to be deleted again and again each time expire runs
  223. ­  hopefully,  this  will reduce the number of files ›4mexpire›24m `for­
  224. gets' in the news tree ...
  225. You may redirect ›4mexpire›24m's stderr stream with ›1m­e›22m ›1mfilename›22m; the new
  226. output  get's appended to ›1mfilename›22m. ›1mWARNING:›22m if ›4mexpire›24m isn't able
  227. to open ›1mfilename›22m, it quits with an error message.
  228. Furthermore, ›4mexpire›24m locks itself (with ›1mexpire.runs›22m), thus you may
  229. run  expire  safely  on a regular basis (for example via ›1mcrontab›22m)
  230. without error prone pseudo locking (›1mif›22m ›1mexists›22m ›1m...›22m ›1mskip›22m ›1mlab›22m ›1mback›22m).
  231. But you may prefer to use the supplied script ›4mdoexpire›24m
  232.  
  233.  
  234.  
  235.      ›4mFixactive›24m  keeps  the  act_min  field  in  the  active  file
  236. (›1muulib:news/active›22m) up to  date.  Fixactive  locks  relaynews  to
  237. avoid  problems  arising from inconsistencies in the active file.
  238. Fixactive should be called after each invocation of expire ­ com­
  239. pare the supplied script ›4mdoexpire›24m.
  240.  
  241.  
  242.  
  243.      ›4mRnews›24m  copies it's stdin (the files may also be given as ar­
  244. guments) to ›1muunews:in.coming›22m.  The following headers are  removed
  245. before  copying:  ›1m#!›22m ›1mcunbatch›22m,   ›1m#!›22m ›1mc7unbatch›22m,  and  ›1m#!›22m ›1mfunbatch›22m.
  246. The latter is used for  frozen  news  batches  frequently.  Rnews
  247. recognises compressed and frozen news batches based on their mag­
  248. ic values; the final name of a compressed news batch gets a  suf­
  249. fix  of ›1m.Z›22m, a frozen one a ›1m.F›22m ­ this is simply for the benefit of
  250. scripts; ›4mnewsrun›24m/›4munbatch›24m do not rely on this feature.
  251.  
  252. Additionally, I change the final file name each time  an  attempt
  253. to  rename  the  temporary  file to it's final name.  As the file
  254. name is taken from ›1mtime();›22m (if rnews is processing it's stdin and
  255. not  a  file  supplied as an argument; in this case, the creation
  256. date of that file, gotten from the ›1mstat()›22m system call, is  used),
  257. this  means you will run in trouble if your system is fast enough
  258. to run about 100 rnews processes within one  second  (you'll  get
  259.  
  260.  
  261.  
  262. Villa Straylight Mon, 11 Jan 1993 06:04:20 +0100                4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. Install.Amiga(­)              wCNews             Install.Amiga(­)
  269.  
  270.  
  271. the error message ›1mtoo›22m ›1mmany›22m ›1mattempts›22m ›1mto›22m ›1mlink›22m ›1m`%s'›22m and a file named
  272. ›1mnspool.XXXXXX›22m will be left in  the  in.coming  directory).  Well,
  273. this works for me; in case of problems, drop me a note.
  274.  
  275. Finally,   rnews   is   able   to   check   the   free  space  on
  276. ›1muunews:in.coming/›22m before trying to copy ­­ this may cut down  ma­
  277. chine's  load  in  case it matters (it's faster to check the free
  278. space than to copy files and  detect  the  shortage  while  doing
  279. this).  Unfortunately,  when  processing  standard  input,  rnews
  280. doesn't know the amoung of data to be processed ...
  281. You can specify a minimum of bytes that must be available on  the
  282. filesystem    containing    the    ›1min.coming›22m    directory    with
  283. ›1mRNEWS.MinTmpSpace›22m ­­ for input from stdin, rnews will  refuse  to
  284. copy if there are less than ›1mRNEWS.MinTmpSpace›22m bytes free; for in­
  285. put from normal files, the comparation if done against the  file­
  286. size (›4mst.st_size›24m).
  287. To turn this feature off, either omit ›1mRNEWS.MinTmpSpace›22m from your
  288. configuration or set it to 0.
  289.  
  290. If started with the ›1m­i›22m flag, rnews does a  ›4msystem("run›24m ›4munbatch");›24m
  291. after  processing all files, which should start a backgroung pro­
  292. cess executing unbatch. This implies that
  293.  
  294.   · the ›4munbatch›24m executable is  in  the  current  AmigaDOS  search
  295.     path,
  296.  
  297.   · and ›4munbatch›24m prevents itself from running more that once.
  298.  
  299. To  force  the  usage  of  ›1m­i›22m,  add  a  line  "RNEWS rnews ­i" to
  300. ›1muulib:Config.›22m
  301.  
  302.  
  303.  
  304.      ›4mUnbatch›24m/›4mnewsrun›24m processes incoming news  batches  (filed  in
  305. ›1muunews:in.coming›22m).  ›4mUnbatch›24m is the same binary as newsrun, so you
  306. may want to replace one of them with a hardlink to the  remaining
  307. in  order  to  save disk space; the difference is that ›4mnewsrun›24m is
  308. expected to run as a daemon while ›4munbatch›24m should be called  manu­
  309. ally (e. g. periodically from crontab).
  310.  
  311.      ›4mNewsrun›24m  is  intended to be run in the background but hasn't
  312.      finished yet. ›1mNOTE:›22m ›1mAS›22m ›1mOF›22m ›1mTHIS›22m ›1mWRITING,›22m ›1mDON'T›22m ›1mUSE›22m ›1mnewsrun›22m ›1mAS›22m
  313.      ›1mA›22m ›1mDAEMON,›22m ›1mIT›22m ›1mCONSUMES›22m ›1mMEMORY›22m ›1mEACH›22m ›1mTIME›22m ›1mIT›22m ›1mSCANS›22m ›1mTHE›22m ›1mINCOMING›22m
  314.      ›1mDIRECTORY›22m ›1mWHICH›22m ›1mIS›22m ›1mNOT›22m ›1mFREED›22m ›1mUNTIL›22m ›1mnewsrun›22m ›1mEXITS›22m.
  315.  
  316. ›4mUnbatch›24m (until further notice, the following also applies to  the
  317. binaries'  ›4mnewsrun›24m operation) pipes the batch through ›4mcompress›24m or
  318. ›4mfreeze›24m for decompression if  neccessary;  finally,  the  data  is
  319. piped  into ›4mrelaynews›24m. If any command returns non­zero, for exam­
  320. ple in case of ›1mout›22m ›1mof›22m ›1mmemory›22m for ›4mcompress›24m or an error detected by
  321. ›4mrelaynews›24m, the batch is moved into the ›1mbad›22m subdirectory for human
  322. investigation. Currently, there is no way to limit the number  of
  323. bad batches in ›1mbad›22m nor any notification by mail to ›1mNEWSMASTER›22m nor
  324. a check for enough free space on ›1muunews:›22m. This is planned for the
  325.  
  326.  
  327.  
  328. Villa Straylight Mon, 11 Jan 1993 06:04:20 +0100                5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. Install.Amiga(­)              wCNews             Install.Amiga(­)
  335.  
  336.  
  337. next release, i. e. for the rewrite of ›4mnewsrun›24m/›4munbatch›24m.
  338. ›4mUnbatch›24m  checks  the  free  space on ›1min.coming›22m's parent directory
  339. (usually ›1muunews:›22m) before it  attempts  to  actually  process  the
  340. batch.  (Assumes  an  uncompressed  batch  to grow by 50%, a com­
  341. pressed one to consume 2.5, and a  frozen  batch  3.0  times  the
  342. space  it  occupies now.  This may be magnitudes to low (consider
  343. an article consisting of 1 MB spaces), but I know of no fast  way
  344. to determine the actual size =:­<)
  345. This  should  work fine, but isn't secure ... First, the space an
  346. article takes on disk is usually more than the  plain  byte  size
  347. (just  consider  the  file  system  overhead/links, new ›1mPath:›22m and
  348. ›1mXRef:›22m headers, ...).  Second, other tasks may write to  the  news
  349. partition after the ›4mspaceleft()›24m call, reducing the available file
  350. system space.
  351. It is intended to cope better  with  low  disk  space  situations
  352. (doesn't make much sense to start relaynews knowing it will fail)
  353. ­­ ›4munbatch›24m won't move a batch in case it detects it wouldn't  fit
  354. on  disk,  thus allowing this batch to be processed automatically
  355. as soon as disk usage permits (instead of  moving  the  batch  to
  356. ›1min.coming/bad›22m  after ›4mrelaynews›24m complained).  Not perfect, I admit
  357. ­­ I'm open for suggestions ...
  358.  
  359.  
  360. ›1mAuthor's›22m ›1maddress›22m
  361.  
  362.      Please   send   all   queries,   bug   reports,   etc.    to
  363. ›1mwusel@hactar.›22m(›1mUUCP›22m|›1mhanse.de›22m) ›1m(Kai›22m ›1m'wusel'›22m ›1mSiering)›22m.
  364. For  bug  reports,  ›1mplease›22m use the supplied script ›4mbugreport›24m; for
  365. enhancement requests, ›1mplease›22m  use  the  supplied  ›4mfeaturerequest›24m­
  366. script.  For anything else, use plain email =:­>
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. Villa Straylight Mon, 11 Jan 1993 06:04:20 +0100                6
  395.  
  396.  
  397.